metronome-sdk 0.1.0.pre.alpha.1

data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Contracts
+        module RateCards
+          # @see MetronomeSDK::Resources::V1::Contracts::RateCards::Rates#add
+          class RateAddResponse < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data]
+            required :data, -> { MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data }
+
+            # @!method initialize(data:)
+            #   @param data [MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data]
+
+            # @see MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse#data
+            class Data < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute rate_type
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::RateType]
+              required :rate_type,
+                       enum: -> { MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::RateType }
+
+              # @!attribute commit_rate
+              #   A distinct rate on the rate card. You can choose to use this rate rather than
+              #   list rate when consuming a credit or commit.
+              #
+              #   @return [MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate, nil]
+              optional :commit_rate,
+                       -> { MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate }
+
+              # @!attribute credit_type
+              #
+              #   @return [MetronomeSDK::Models::CreditTypeData, nil]
+              optional :credit_type, -> { MetronomeSDK::Models::CreditTypeData }
+
+              # @!attribute custom_rate
+              #   Only set for CUSTOM rate_type. This field is interpreted by custom rate
+              #   processors.
+              #
+              #   @return [Hash{Symbol=>Object}, nil]
+              optional :custom_rate,
+                       MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+              # @!attribute is_prorated
+              #   Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+              #   set to true.
+              #
+              #   @return [Boolean, nil]
+              optional :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+              # @!attribute price
+              #   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.
+              #
+              #   @return [Float, nil]
+              optional :price, Float
+
+              # @!attribute pricing_group_values
+              #   if pricing groups are used, this will contain the values used to calculate the
+              #   price
+              #
+              #   @return [Hash{Symbol=>String}, nil]
+              optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
+
+              # @!attribute quantity
+              #   Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+              #
+              #   @return [Float, nil]
+              optional :quantity, Float
+
+              # @!attribute tiers
+              #   Only set for TIERED rate_type.
+              #
+              #   @return [Array<MetronomeSDK::Models::Tier>, nil]
+              optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::Tier] }
+
+              # @!attribute use_list_prices
+              #   Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
+              #   using list prices rather than the standard rates for this product on the
+              #   contract.
+              #
+              #   @return [Boolean, nil]
+              optional :use_list_prices, MetronomeSDK::Internal::Type::Boolean
+
+              # @!method initialize(rate_type:, commit_rate: nil, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data} for more
+              #   details.
+              #
+              #   @param rate_type [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::RateType]
+              #
+              #   @param commit_rate [MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate] A distinct rate on the rate card. You can choose to use this rate rather than li
+              #   ...
+              #
+              #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
+              #
+              #   @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
+              #   ...
+              #
+              #   @param is_prorated [Boolean] Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+              #   ...
+              #
+              #   @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
+              #   ...
+              #
+              #   @param pricing_group_values [Hash{Symbol=>String}] if pricing groups are used, this will contain the values used to calculate the p
+              #   ...
+              #
+              #   @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+              #
+              #   @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
+              #
+              #   @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
+              #   ...
+
+              # @see MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data#rate_type
+              module RateType
+                extend MetronomeSDK::Internal::Type::Enum
+
+                FLAT = :FLAT
+                PERCENTAGE = :PERCENTAGE
+                SUBSCRIPTION = :SUBSCRIPTION
+                CUSTOM = :CUSTOM
+                TIERED = :TIERED
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # @see MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data#commit_rate
+              class CommitRate < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute rate_type
+                #
+                #   @return [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate::RateType]
+                required :rate_type,
+                         enum: -> { MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate::RateType }
+
+                # @!attribute price
+                #   Commit rate price. For FLAT rate_type, this must be >=0.
+                #
+                #   @return [Float, nil]
+                optional :price, Float
+
+                # @!attribute tiers
+                #   Only set for TIERED rate_type.
+                #
+                #   @return [Array<MetronomeSDK::Models::Tier>, nil]
+                optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::Tier] }
+
+                # @!method initialize(rate_type:, price: nil, tiers: nil)
+                #   A distinct rate on the rate card. You can choose to use this rate rather than
+                #   list rate when consuming a credit or commit.
+                #
+                #   @param rate_type [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate::RateType]
+                #
+                #   @param price [Float] Commit rate price. For FLAT rate_type, this must be >=0.
+                #
+                #   @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
+
+                # @see MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate#rate_type
+                module RateType
+                  extend MetronomeSDK::Internal::Type::Enum
+
+                  FLAT = :FLAT
+                  PERCENTAGE = :PERCENTAGE
+                  SUBSCRIPTION = :SUBSCRIPTION
+                  TIERED = :TIERED
+                  CUSTOM = :CUSTOM
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Contracts
+        module RateCards
+          # @see MetronomeSDK::Resources::V1::Contracts::RateCards::Rates#list
+          class RateListParams < MetronomeSDK::Internal::Type::BaseModel
+            extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+            include MetronomeSDK::Internal::Type::RequestParameters
+
+            # @!attribute at
+            #   inclusive starting point for the rates schedule
+            #
+            #   @return [Time]
+            required :at, Time
+
+            # @!attribute rate_card_id
+            #   ID of the rate card to get the schedule for
+            #
+            #   @return [String]
+            required :rate_card_id, String
+
+            # @!attribute limit
+            #   Max number of results that should be returned
+            #
+            #   @return [Integer, nil]
+            optional :limit, Integer
+
+            # @!attribute next_page
+            #   Cursor that indicates where the next page of results should start.
+            #
+            #   @return [String, nil]
+            optional :next_page, String
+
+            # @!attribute selectors
+            #   List of rate selectors, rates matching ANY of the selector will be included in
+            #   the response Passing no selectors will result in all rates being returned.
+            #
+            #   @return [Array<MetronomeSDK::Models::V1::Contracts::RateCards::RateListParams::Selector>, nil]
+            optional :selectors,
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Contracts::RateCards::RateListParams::Selector] }
+
+            # @!method initialize(at:, rate_card_id:, limit: nil, next_page: nil, selectors: nil, request_options: {})
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::Contracts::RateCards::RateListParams} for more
+            #   details.
+            #
+            #   @param at [Time] inclusive starting point for the rates schedule
+            #
+            #   @param rate_card_id [String] ID of the rate card to get the schedule for
+            #
+            #   @param limit [Integer] Max number of results that should be returned
+            #
+            #   @param next_page [String] Cursor that indicates where the next page of results should start.
+            #
+            #   @param selectors [Array<MetronomeSDK::Models::V1::Contracts::RateCards::RateListParams::Selector>] List of rate selectors, rates matching ANY of the selector will be included in t
+            #   ...
+            #
+            #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+            class Selector < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute partial_pricing_group_values
+              #   List of pricing group key value pairs, rates containing the matching key / value
+              #   pairs will be included in the response.
+              #
+              #   @return [Hash{Symbol=>String}, nil]
+              optional :partial_pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
+
+              # @!attribute pricing_group_values
+              #   List of pricing group key value pairs, rates matching all of the key / value
+              #   pairs will be included in the response.
+              #
+              #   @return [Hash{Symbol=>String}, nil]
+              optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
+
+              # @!attribute product_id
+              #   Rates matching the product id will be included in the response.
+              #
+              #   @return [String, nil]
+              optional :product_id, String
+
+              # @!attribute product_tags
+              #   List of product tags, rates matching any of the tags will be included in the
+              #   response.
+              #
+              #   @return [Array<String>, nil]
+              optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+              # @!method initialize(partial_pricing_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {MetronomeSDK::Models::V1::Contracts::RateCards::RateListParams::Selector} for
+              #   more details.
+              #
+              #   @param partial_pricing_group_values [Hash{Symbol=>String}] List of pricing group key value pairs, rates containing the matching key / value
+              #   ...
+              #
+              #   @param pricing_group_values [Hash{Symbol=>String}] List of pricing group key value pairs, rates matching all of the key / value pai
+              #   ...
+              #
+              #   @param product_id [String] Rates matching the product id will be included in the response.
+              #
+              #   @param product_tags [Array<String>] List of product tags, rates matching any of the tags will be included in the res
+              #   ...
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Contracts
+        module RateCards
+          # @see MetronomeSDK::Resources::V1::Contracts::RateCards::Rates#list
+          class RateListResponse < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute entitled
+            #
+            #   @return [Boolean]
+            required :entitled, MetronomeSDK::Internal::Type::Boolean
+
+            # @!attribute product_custom_fields
+            #
+            #   @return [Hash{Symbol=>String}]
+            required :product_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+            # @!attribute product_id
+            #
+            #   @return [String]
+            required :product_id, String
+
+            # @!attribute product_name
+            #
+            #   @return [String]
+            required :product_name, String
+
+            # @!attribute product_tags
+            #
+            #   @return [Array<String>]
+            required :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+            # @!attribute rate
+            #
+            #   @return [MetronomeSDK::Models::Rate]
+            required :rate, -> { MetronomeSDK::Models::Rate }
+
+            # @!attribute starting_at
+            #
+            #   @return [Time]
+            required :starting_at, Time
+
+            # @!attribute commit_rate
+            #   A distinct rate on the rate card. You can choose to use this rate rather than
+            #   list rate when consuming a credit or commit.
+            #
+            #   @return [MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::CommitRate, nil]
+            optional :commit_rate, -> { MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::CommitRate }
+
+            # @!attribute ending_before
+            #
+            #   @return [Time, nil]
+            optional :ending_before, Time
+
+            # @!attribute pricing_group_values
+            #
+            #   @return [Hash{Symbol=>String}, nil]
+            optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
+
+            # @!method initialize(entitled:, product_custom_fields:, product_id:, product_name:, product_tags:, rate:, starting_at:, commit_rate: nil, ending_before: nil, pricing_group_values: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse} for more
+            #   details.
+            #
+            #   @param entitled [Boolean]
+            #
+            #   @param product_custom_fields [Hash{Symbol=>String}]
+            #
+            #   @param product_id [String]
+            #
+            #   @param product_name [String]
+            #
+            #   @param product_tags [Array<String>]
+            #
+            #   @param rate [MetronomeSDK::Models::Rate]
+            #
+            #   @param starting_at [Time]
+            #
+            #   @param commit_rate [MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::CommitRate] A distinct rate on the rate card. You can choose to use this rate rather than li
+            #   ...
+            #
+            #   @param ending_before [Time]
+            #
+            #   @param pricing_group_values [Hash{Symbol=>String}]
+
+            # @see MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse#commit_rate
+            class CommitRate < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute rate_type
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::CommitRate::RateType]
+              required :rate_type,
+                       enum: -> { MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::CommitRate::RateType }
+
+              # @!attribute price
+              #   Commit rate price. For FLAT rate_type, this must be >=0.
+              #
+              #   @return [Float, nil]
+              optional :price, Float
+
+              # @!attribute tiers
+              #   Only set for TIERED rate_type.
+              #
+              #   @return [Array<MetronomeSDK::Models::Tier>, nil]
+              optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::Tier] }
+
+              # @!method initialize(rate_type:, price: nil, tiers: nil)
+              #   A distinct rate on the rate card. You can choose to use this rate rather than
+              #   list rate when consuming a credit or commit.
+              #
+              #   @param rate_type [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::CommitRate::RateType]
+              #
+              #   @param price [Float] Commit rate price. For FLAT rate_type, this must be >=0.
+              #
+              #   @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
+
+              # @see MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::CommitRate#rate_type
+              module RateType
+                extend MetronomeSDK::Internal::Type::Enum
+
+                FLAT = :FLAT
+                PERCENTAGE = :PERCENTAGE
+                SUBSCRIPTION = :SUBSCRIPTION
+                TIERED = :TIERED
+                CUSTOM = :CUSTOM
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,233 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::CreditGrants#create
+      class CreditGrantCreateParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #   the Metronome ID of the customer
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute expires_at
+        #   The credit grant will only apply to usage or charges dated before this timestamp
+        #
+        #   @return [Time]
+        required :expires_at, Time
+
+        # @!attribute grant_amount
+        #   the amount of credits granted
+        #
+        #   @return [MetronomeSDK::Models::V1::CreditGrantCreateParams::GrantAmount]
+        required :grant_amount, -> { MetronomeSDK::Models::V1::CreditGrantCreateParams::GrantAmount }
+
+        # @!attribute name
+        #   the name of the credit grant as it will appear on invoices
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute paid_amount
+        #   the amount paid for this credit grant
+        #
+        #   @return [MetronomeSDK::Models::V1::CreditGrantCreateParams::PaidAmount]
+        required :paid_amount, -> { MetronomeSDK::Models::V1::CreditGrantCreateParams::PaidAmount }
+
+        # @!attribute priority
+        #
+        #   @return [Float]
+        required :priority, Float
+
+        # @!attribute credit_grant_type
+        #
+        #   @return [String, nil]
+        optional :credit_grant_type, String
+
+        # @!attribute custom_fields
+        #   Custom fields to attach to the credit grant.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+        # @!attribute effective_at
+        #   The credit grant will only apply to usage or charges dated on or after this
+        #   timestamp
+        #
+        #   @return [Time, nil]
+        optional :effective_at, Time
+
+        # @!attribute invoice_date
+        #   The date to issue an invoice for the paid_amount.
+        #
+        #   @return [Time, nil]
+        optional :invoice_date, Time
+
+        # @!attribute product_ids
+        #   The product(s) which these credits will be applied to. (If unspecified, the
+        #   credits will be applied to charges for all products.). The array ordering
+        #   specified here will be used to determine the order in which credits will be
+        #   applied to invoice line items
+        #
+        #   @return [Array<String>, nil]
+        optional :product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute reason
+        #
+        #   @return [String, nil]
+        optional :reason, String
+
+        # @!attribute rollover_settings
+        #   Configure a rollover for this credit grant so if it expires it rolls over a
+        #   configured amount to a new credit grant. This feature is currently opt-in only.
+        #   Contact Metronome to be added to the beta.
+        #
+        #   @return [MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings, nil]
+        optional :rollover_settings, -> { MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings }
+
+        # @!attribute uniqueness_key
+        #   Prevents the creation of duplicates. If a request to create a record is made
+        #   with a previously used uniqueness key, a new record will not be created and the
+        #   request will fail with a 409 error.
+        #
+        #   @return [String, nil]
+        optional :uniqueness_key, String
+
+        # @!method initialize(customer_id:, expires_at:, grant_amount:, name:, paid_amount:, priority:, credit_grant_type: nil, custom_fields: nil, effective_at: nil, invoice_date: nil, product_ids: nil, reason: nil, rollover_settings: nil, uniqueness_key: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::CreditGrantCreateParams} for more details.
+        #
+        #   @param customer_id [String] the Metronome ID of the customer
+        #
+        #   @param expires_at [Time] The credit grant will only apply to usage or charges dated before this timestamp
+        #   ...
+        #
+        #   @param grant_amount [MetronomeSDK::Models::V1::CreditGrantCreateParams::GrantAmount] the amount of credits granted
+        #
+        #   @param name [String] the name of the credit grant as it will appear on invoices
+        #
+        #   @param paid_amount [MetronomeSDK::Models::V1::CreditGrantCreateParams::PaidAmount] the amount paid for this credit grant
+        #
+        #   @param priority [Float]
+        #
+        #   @param credit_grant_type [String]
+        #
+        #   @param custom_fields [Hash{Symbol=>String}] Custom fields to attach to the credit grant.
+        #
+        #   @param effective_at [Time] The credit grant will only apply to usage or charges dated on or after this time
+        #   ...
+        #
+        #   @param invoice_date [Time] The date to issue an invoice for the paid_amount.
+        #
+        #   @param product_ids [Array<String>] The product(s) which these credits will be applied to. (If unspecified, the cred
+        #   ...
+        #
+        #   @param reason [String]
+        #
+        #   @param rollover_settings [MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings] Configure a rollover for this credit grant so if it expires it rolls over a conf
+        #   ...
+        #
+        #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
+        #   ...
+        #
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+        class GrantAmount < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute amount
+          #
+          #   @return [Float]
+          required :amount, Float
+
+          # @!attribute credit_type_id
+          #   the ID of the pricing unit to be used. Defaults to USD (cents) if not passed.
+          #
+          #   @return [String]
+          required :credit_type_id, String
+
+          # @!method initialize(amount:, credit_type_id:)
+          #   the amount of credits granted
+          #
+          #   @param amount [Float]
+          #
+          #   @param credit_type_id [String] the ID of the pricing unit to be used. Defaults to USD (cents) if not passed.
+        end
+
+        class PaidAmount < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute amount
+          #
+          #   @return [Float]
+          required :amount, Float
+
+          # @!attribute credit_type_id
+          #   the ID of the pricing unit to be used. Defaults to USD (cents) if not passed.
+          #
+          #   @return [String]
+          required :credit_type_id, String
+
+          # @!method initialize(amount:, credit_type_id:)
+          #   the amount paid for this credit grant
+          #
+          #   @param amount [Float]
+          #
+          #   @param credit_type_id [String] the ID of the pricing unit to be used. Defaults to USD (cents) if not passed.
+        end
+
+        class RolloverSettings < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute expires_at
+          #   The date to expire the rollover credits.
+          #
+          #   @return [Time]
+          required :expires_at, Time
+
+          # @!attribute priority
+          #   The priority to give the rollover credit grant that gets created when a rollover
+          #   happens.
+          #
+          #   @return [Float]
+          required :priority, Float
+
+          # @!attribute rollover_amount
+          #   Specify how much to rollover to the rollover credit grant
+          #
+          #   @return [MetronomeSDK::Models::V1::RolloverAmountMaxPercentage, MetronomeSDK::Models::V1::RolloverAmountMaxAmount]
+          required :rollover_amount,
+                   union: -> { MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount }
+
+          # @!method initialize(expires_at:, priority:, rollover_amount:)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings} for more
+          #   details.
+          #
+          #   Configure a rollover for this credit grant so if it expires it rolls over a
+          #   configured amount to a new credit grant. This feature is currently opt-in only.
+          #   Contact Metronome to be added to the beta.
+          #
+          #   @param expires_at [Time] The date to expire the rollover credits.
+          #
+          #   @param priority [Float] The priority to give the rollover credit grant that gets created when a rollover
+          #   ...
+          #
+          #   @param rollover_amount [MetronomeSDK::Models::V1::RolloverAmountMaxPercentage, MetronomeSDK::Models::V1::RolloverAmountMaxAmount] Specify how much to rollover to the rollover credit grant
+
+          # Specify how much to rollover to the rollover credit grant
+          #
+          # @see MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings#rollover_amount
+          module RolloverAmount
+            extend MetronomeSDK::Internal::Type::Union
+
+            variant -> { MetronomeSDK::Models::V1::RolloverAmountMaxPercentage }
+
+            variant -> { MetronomeSDK::Models::V1::RolloverAmountMaxAmount }
+
+            # @!method self.variants
+            #   @return [Array(MetronomeSDK::Models::V1::RolloverAmountMaxPercentage, MetronomeSDK::Models::V1::RolloverAmountMaxAmount)]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::CreditGrants#create
+      class CreditGrantCreateResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [MetronomeSDK::Models::ID]
+        required :data, -> { MetronomeSDK::Models::ID }
+
+        # @!method initialize(data:)
+        #   @param data [MetronomeSDK::Models::ID]
+      end
+    end
+  end
+end