metronome-sdk 0.1.0.pre.alpha.3 → 0.1.0

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

@@ -8,22 +8,11 @@ module MetronomeSDK
         class PlanAddResponse < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute data
           #
-          #   @return [MetronomeSDK::Models::V1::Customers::PlanAddResponse::Data]
-          required :data, -> { MetronomeSDK::Models::V1::Customers::PlanAddResponse::Data }
+          #   @return [MetronomeSDK::Models::ID]
+          required :data, -> { MetronomeSDK::ID }
 
           # @!method initialize(data:)
-          #   @param data [MetronomeSDK::Models::V1::Customers::PlanAddResponse::Data]
-
-          # @see MetronomeSDK::Models::V1::Customers::PlanAddResponse#data
-          class Data < MetronomeSDK::Internal::Type::BaseModel
-            # @!attribute id
-            #
-            #   @return [String]
-            required :id, String
-
-            # @!method initialize(id:)
-            #   @param id [String]
-          end
+          #   @param data [MetronomeSDK::Models::ID]
         end
       end
     end

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

@@ -102,31 +102,13 @@ module MetronomeSDK
 
               # @!attribute credit_type
               #
-              #   @return [MetronomeSDK::Models::V1::Customers::PlanListResponse::TrialInfo::SpendingCap::CreditType]
-              required :credit_type,
-                       -> { MetronomeSDK::Models::V1::Customers::PlanListResponse::TrialInfo::SpendingCap::CreditType }
+              #   @return [MetronomeSDK::Models::CreditTypeData]
+              required :credit_type, -> { MetronomeSDK::CreditTypeData }
 
               # @!method initialize(amount:, amount_remaining:, credit_type:)
               #   @param amount [Float]
               #   @param amount_remaining [Float]
-              #   @param credit_type [MetronomeSDK::Models::V1::Customers::PlanListResponse::TrialInfo::SpendingCap::CreditType]
-
-              # @see MetronomeSDK::Models::V1::Customers::PlanListResponse::TrialInfo::SpendingCap#credit_type
-              class CreditType < MetronomeSDK::Internal::Type::BaseModel
-                # @!attribute id
-                #
-                #   @return [String]
-                required :id, String
-
-                # @!attribute name
-                #
-                #   @return [String]
-                required :name, String
-
-                # @!method initialize(id:, name:)
-                #   @param id [String]
-                #   @param name [String]
-              end
+              #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
             end
           end
         end

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

@@ -66,6 +66,7 @@ module MetronomeSDK
           INVOICES = :invoices
           USAGE = :usage
           CREDITS = :credits
+          COMMITS_AND_CREDITS = :commits_and_credits
 
           # @!method self.values
           #   @return [Array<Symbol>]

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

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      class PlanDetail < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute custom_fields
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute credit_grants
+        #
+        #   @return [Array<MetronomeSDK::Models::V1::PlanDetail::CreditGrant>, nil]
+        optional :credit_grants,
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::CreditGrant] }
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute minimums
+        #
+        #   @return [Array<MetronomeSDK::Models::V1::PlanDetail::Minimum>, nil]
+        optional :minimums,
+                 -> {
+                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::Minimum]
+                 }
+
+        # @!attribute overage_rates
+        #
+        #   @return [Array<MetronomeSDK::Models::V1::PlanDetail::OverageRate>, nil]
+        optional :overage_rates,
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::OverageRate] }
+
+        # @!method initialize(id:, custom_fields:, name:, credit_grants: nil, description: nil, minimums: nil, overage_rates: nil)
+        #   @param id [String]
+        #   @param custom_fields [Hash{Symbol=>String}]
+        #   @param name [String]
+        #   @param credit_grants [Array<MetronomeSDK::Models::V1::PlanDetail::CreditGrant>]
+        #   @param description [String]
+        #   @param minimums [Array<MetronomeSDK::Models::V1::PlanDetail::Minimum>]
+        #   @param overage_rates [Array<MetronomeSDK::Models::V1::PlanDetail::OverageRate>]
+
+        class CreditGrant < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute amount_granted
+          #
+          #   @return [Float]
+          required :amount_granted, Float
+
+          # @!attribute amount_granted_credit_type
+          #
+          #   @return [MetronomeSDK::Models::CreditTypeData]
+          required :amount_granted_credit_type, -> { MetronomeSDK::CreditTypeData }
+
+          # @!attribute amount_paid
+          #
+          #   @return [Float]
+          required :amount_paid, Float
+
+          # @!attribute amount_paid_credit_type
+          #
+          #   @return [MetronomeSDK::Models::CreditTypeData]
+          required :amount_paid_credit_type, -> { MetronomeSDK::CreditTypeData }
+
+          # @!attribute effective_duration
+          #
+          #   @return [Float]
+          required :effective_duration, Float
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute priority
+          #
+          #   @return [String]
+          required :priority, String
+
+          # @!attribute send_invoice
+          #
+          #   @return [Boolean]
+          required :send_invoice, MetronomeSDK::Internal::Type::Boolean
+
+          # @!attribute reason
+          #
+          #   @return [String, nil]
+          optional :reason, String
+
+          # @!attribute recurrence_duration
+          #
+          #   @return [Float, nil]
+          optional :recurrence_duration, Float
+
+          # @!attribute recurrence_interval
+          #
+          #   @return [Float, nil]
+          optional :recurrence_interval, Float
+
+          # @!method initialize(amount_granted:, amount_granted_credit_type:, amount_paid:, amount_paid_credit_type:, effective_duration:, name:, priority:, send_invoice:, reason: nil, recurrence_duration: nil, recurrence_interval: nil)
+          #   @param amount_granted [Float]
+          #   @param amount_granted_credit_type [MetronomeSDK::Models::CreditTypeData]
+          #   @param amount_paid [Float]
+          #   @param amount_paid_credit_type [MetronomeSDK::Models::CreditTypeData]
+          #   @param effective_duration [Float]
+          #   @param name [String]
+          #   @param priority [String]
+          #   @param send_invoice [Boolean]
+          #   @param reason [String]
+          #   @param recurrence_duration [Float]
+          #   @param recurrence_interval [Float]
+        end
+
+        class Minimum < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute credit_type
+          #
+          #   @return [MetronomeSDK::Models::CreditTypeData]
+          required :credit_type, -> { MetronomeSDK::CreditTypeData }
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute start_period
+          #   Used in price ramps. Indicates how many billing periods pass before the charge
+          #   applies.
+          #
+          #   @return [Float]
+          required :start_period, Float
+
+          # @!attribute value
+          #
+          #   @return [Float]
+          required :value, Float
+
+          # @!method initialize(credit_type:, name:, start_period:, value:)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::PlanDetail::Minimum} for more details.
+          #
+          #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
+          #
+          #   @param name [String]
+          #
+          #   @param start_period [Float] Used in price ramps. Indicates how many billing periods pass before the charge
+          #
+          #   @param value [Float]
+        end
+
+        class OverageRate < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute credit_type
+          #
+          #   @return [MetronomeSDK::Models::CreditTypeData]
+          required :credit_type, -> { MetronomeSDK::CreditTypeData }
+
+          # @!attribute fiat_credit_type
+          #
+          #   @return [MetronomeSDK::Models::CreditTypeData]
+          required :fiat_credit_type, -> { MetronomeSDK::CreditTypeData }
+
+          # @!attribute start_period
+          #   Used in price ramps. Indicates how many billing periods pass before the charge
+          #   applies.
+          #
+          #   @return [Float]
+          required :start_period, Float
+
+          # @!attribute to_fiat_conversion_factor
+          #
+          #   @return [Float]
+          required :to_fiat_conversion_factor, Float
+
+          # @!method initialize(credit_type:, fiat_credit_type:, start_period:, to_fiat_conversion_factor:)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::PlanDetail::OverageRate} for more details.
+          #
+          #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
+          #
+          #   @param fiat_credit_type [MetronomeSDK::Models::CreditTypeData]
+          #
+          #   @param start_period [Float] Used in price ramps. Indicates how many billing periods pass before the charge
+          #
+          #   @param to_fiat_conversion_factor [Float]
+        end
+      end
+    end
+  end
+end

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

@@ -7,294 +7,11 @@ module MetronomeSDK
       class PlanGetDetailsResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data]
-        required :data, -> { MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data }
+        #   @return [MetronomeSDK::Models::V1::PlanDetail]
+        required :data, -> { MetronomeSDK::V1::PlanDetail }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data]
-
-        # @see MetronomeSDK::Models::V1::PlanGetDetailsResponse#data
-        class Data < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute custom_fields
-          #
-          #   @return [Hash{Symbol=>String}]
-          required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
-
-          # @!attribute name
-          #
-          #   @return [String]
-          required :name, String
-
-          # @!attribute credit_grants
-          #
-          #   @return [Array<MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant>, nil]
-          optional :credit_grants,
-                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant] }
-
-          # @!attribute description
-          #
-          #   @return [String, nil]
-          optional :description, String
-
-          # @!attribute minimums
-          #
-          #   @return [Array<MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum>, nil]
-          optional :minimums,
-                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum] }
-
-          # @!attribute overage_rates
-          #
-          #   @return [Array<MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate>, nil]
-          optional :overage_rates,
-                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate] }
-
-          # @!method initialize(id:, custom_fields:, name:, credit_grants: nil, description: nil, minimums: nil, overage_rates: nil)
-          #   @param id [String]
-          #   @param custom_fields [Hash{Symbol=>String}]
-          #   @param name [String]
-          #   @param credit_grants [Array<MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant>]
-          #   @param description [String]
-          #   @param minimums [Array<MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum>]
-          #   @param overage_rates [Array<MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate>]
-
-          class CreditGrant < MetronomeSDK::Internal::Type::BaseModel
-            # @!attribute amount_granted
-            #
-            #   @return [Float]
-            required :amount_granted, Float
-
-            # @!attribute amount_granted_credit_type
-            #
-            #   @return [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant::AmountGrantedCreditType]
-            required :amount_granted_credit_type,
-                     -> { MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant::AmountGrantedCreditType }
-
-            # @!attribute amount_paid
-            #
-            #   @return [Float]
-            required :amount_paid, Float
-
-            # @!attribute amount_paid_credit_type
-            #
-            #   @return [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant::AmountPaidCreditType]
-            required :amount_paid_credit_type,
-                     -> { MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant::AmountPaidCreditType }
-
-            # @!attribute effective_duration
-            #
-            #   @return [Float]
-            required :effective_duration, Float
-
-            # @!attribute name
-            #
-            #   @return [String]
-            required :name, String
-
-            # @!attribute priority
-            #
-            #   @return [String]
-            required :priority, String
-
-            # @!attribute send_invoice
-            #
-            #   @return [Boolean]
-            required :send_invoice, MetronomeSDK::Internal::Type::Boolean
-
-            # @!attribute reason
-            #
-            #   @return [String, nil]
-            optional :reason, String
-
-            # @!attribute recurrence_duration
-            #
-            #   @return [Float, nil]
-            optional :recurrence_duration, Float
-
-            # @!attribute recurrence_interval
-            #
-            #   @return [Float, nil]
-            optional :recurrence_interval, Float
-
-            # @!method initialize(amount_granted:, amount_granted_credit_type:, amount_paid:, amount_paid_credit_type:, effective_duration:, name:, priority:, send_invoice:, reason: nil, recurrence_duration: nil, recurrence_interval: nil)
-            #   @param amount_granted [Float]
-            #   @param amount_granted_credit_type [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant::AmountGrantedCreditType]
-            #   @param amount_paid [Float]
-            #   @param amount_paid_credit_type [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant::AmountPaidCreditType]
-            #   @param effective_duration [Float]
-            #   @param name [String]
-            #   @param priority [String]
-            #   @param send_invoice [Boolean]
-            #   @param reason [String]
-            #   @param recurrence_duration [Float]
-            #   @param recurrence_interval [Float]
-
-            # @see MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant#amount_granted_credit_type
-            class AmountGrantedCreditType < MetronomeSDK::Internal::Type::BaseModel
-              # @!attribute id
-              #
-              #   @return [String]
-              required :id, String
-
-              # @!attribute name
-              #
-              #   @return [String]
-              required :name, String
-
-              # @!method initialize(id:, name:)
-              #   @param id [String]
-              #   @param name [String]
-            end
-
-            # @see MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant#amount_paid_credit_type
-            class AmountPaidCreditType < MetronomeSDK::Internal::Type::BaseModel
-              # @!attribute id
-              #
-              #   @return [String]
-              required :id, String
-
-              # @!attribute name
-              #
-              #   @return [String]
-              required :name, String
-
-              # @!method initialize(id:, name:)
-              #   @param id [String]
-              #   @param name [String]
-            end
-          end
-
-          class Minimum < MetronomeSDK::Internal::Type::BaseModel
-            # @!attribute credit_type
-            #
-            #   @return [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum::CreditType]
-            required :credit_type, -> { MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum::CreditType }
-
-            # @!attribute name
-            #
-            #   @return [String]
-            required :name, String
-
-            # @!attribute start_period
-            #   Used in price ramps. Indicates how many billing periods pass before the charge
-            #   applies.
-            #
-            #   @return [Float]
-            required :start_period, Float
-
-            # @!attribute value
-            #
-            #   @return [Float]
-            required :value, Float
-
-            # @!method initialize(credit_type:, name:, start_period:, value:)
-            #   Some parameter documentations has been truncated, see
-            #   {MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum} for more
-            #   details.
-            #
-            #   @param credit_type [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum::CreditType]
-            #
-            #   @param name [String]
-            #
-            #   @param start_period [Float] Used in price ramps. Indicates how many billing periods pass before the charge
-            #
-            #   @param value [Float]
-
-            # @see MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum#credit_type
-            class CreditType < MetronomeSDK::Internal::Type::BaseModel
-              # @!attribute id
-              #
-              #   @return [String]
-              required :id, String
-
-              # @!attribute name
-              #
-              #   @return [String]
-              required :name, String
-
-              # @!method initialize(id:, name:)
-              #   @param id [String]
-              #   @param name [String]
-            end
-          end
-
-          class OverageRate < MetronomeSDK::Internal::Type::BaseModel
-            # @!attribute credit_type
-            #
-            #   @return [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate::CreditType]
-            required :credit_type,
-                     -> { MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate::CreditType }
-
-            # @!attribute fiat_credit_type
-            #
-            #   @return [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate::FiatCreditType]
-            required :fiat_credit_type,
-                     -> { MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate::FiatCreditType }
-
-            # @!attribute start_period
-            #   Used in price ramps. Indicates how many billing periods pass before the charge
-            #   applies.
-            #
-            #   @return [Float]
-            required :start_period, Float
-
-            # @!attribute to_fiat_conversion_factor
-            #
-            #   @return [Float]
-            required :to_fiat_conversion_factor, Float
-
-            # @!method initialize(credit_type:, fiat_credit_type:, start_period:, to_fiat_conversion_factor:)
-            #   Some parameter documentations has been truncated, see
-            #   {MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate} for more
-            #   details.
-            #
-            #   @param credit_type [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate::CreditType]
-            #
-            #   @param fiat_credit_type [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate::FiatCreditType]
-            #
-            #   @param start_period [Float] Used in price ramps. Indicates how many billing periods pass before the charge
-            #
-            #   @param to_fiat_conversion_factor [Float]
-
-            # @see MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate#credit_type
-            class CreditType < MetronomeSDK::Internal::Type::BaseModel
-              # @!attribute id
-              #
-              #   @return [String]
-              required :id, String
-
-              # @!attribute name
-              #
-              #   @return [String]
-              required :name, String
-
-              # @!method initialize(id:, name:)
-              #   @param id [String]
-              #   @param name [String]
-            end
-
-            # @see MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate#fiat_credit_type
-            class FiatCreditType < MetronomeSDK::Internal::Type::BaseModel
-              # @!attribute id
-              #
-              #   @return [String]
-              required :id, String
-
-              # @!attribute name
-              #
-              #   @return [String]
-              required :name, String
-
-              # @!method initialize(id:, name:)
-              #   @param id [String]
-              #   @param name [String]
-            end
-          end
-        end
+        #   @param data [MetronomeSDK::Models::V1::PlanDetail]
       end
     end
   end

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

@@ -17,8 +17,8 @@ module MetronomeSDK
 
         # @!attribute credit_type
         #
-        #   @return [MetronomeSDK::Models::V1::PlanListChargesResponse::CreditType]
-        required :credit_type, -> { MetronomeSDK::Models::V1::PlanListChargesResponse::CreditType }
+        #   @return [MetronomeSDK::Models::CreditTypeData]
+        required :credit_type, -> { MetronomeSDK::CreditTypeData }
 
         # @!attribute custom_fields
         #
@@ -79,7 +79,7 @@ module MetronomeSDK
         #
         #   @param charge_type [Symbol, MetronomeSDK::Models::V1::PlanListChargesResponse::ChargeType]
         #
-        #   @param credit_type [MetronomeSDK::Models::V1::PlanListChargesResponse::CreditType]
+        #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
         #
         #   @param custom_fields [Hash{Symbol=>String}]
         #
@@ -113,23 +113,6 @@ module MetronomeSDK
           #   @return [Array<Symbol>]
         end
 
-        # @see MetronomeSDK::Models::V1::PlanListChargesResponse#credit_type
-        class CreditType < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute name
-          #
-          #   @return [String]
-          required :name, String
-
-          # @!method initialize(id:, name:)
-          #   @param id [String]
-          #   @param name [String]
-        end
-
         class Price < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute tier
           #   Used in pricing tiers. Indicates at what metric value the price applies.