Class: MetronomeSDK::Models::V1::PackageCreateParams::ScheduledCharge::Schedule::ScheduleItem

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/package_create_params.rb

Defined Under Namespace

Classes: DateOffset

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(date_offset:, quantity:, unit_price:) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::PackageCreateParams::ScheduledCharge::Schedule::ScheduleItem for more details.

Parameters:



2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2178

class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
  # @!attribute date_offset
  #   Date relative to the contract start date.
  #
  #   @return [MetronomeSDK::Models::V1::PackageCreateParams::ScheduledCharge::Schedule::ScheduleItem::DateOffset]
  required :date_offset,
           -> { MetronomeSDK::V1::PackageCreateParams::ScheduledCharge::Schedule::ScheduleItem::DateOffset }

  # @!attribute quantity
  #   Quantity for the charge. Will be multiplied by unit_price to determine the
  #   amount.
  #
  #   @return [Float]
  required :quantity, Float

  # @!attribute unit_price
  #   Unit price for the charge. Will be multiplied by quantity to determine the
  #   amount.
  #
  #   @return [Float]
  required :unit_price, Float

  # @!method initialize(date_offset:, quantity:, unit_price:)
  #   Some parameter documentations has been truncated, see
  #   {MetronomeSDK::Models::V1::PackageCreateParams::ScheduledCharge::Schedule::ScheduleItem}
  #   for more details.
  #
  #   @param date_offset [MetronomeSDK::Models::V1::PackageCreateParams::ScheduledCharge::Schedule::ScheduleItem::DateOffset] Date relative to the contract start date.
  #
  #   @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
  #
  #   @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun

  # @see MetronomeSDK::Models::V1::PackageCreateParams::ScheduledCharge::Schedule::ScheduleItem#date_offset
  class DateOffset < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute unit
    #
    #   @return [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::ScheduledCharge::Schedule::ScheduleItem::DateOffset::Unit]
    required :unit,
             enum: -> { MetronomeSDK::V1::PackageCreateParams::ScheduledCharge::Schedule::ScheduleItem::DateOffset::Unit }

    # @!attribute value
    #
    #   @return [Integer]
    required :value, Integer

    # @!method initialize(unit:, value:)
    #   Date relative to the contract start date.
    #
    #   @param unit [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::ScheduledCharge::Schedule::ScheduleItem::DateOffset::Unit]
    #   @param value [Integer]

    # @see MetronomeSDK::Models::V1::PackageCreateParams::ScheduledCharge::Schedule::ScheduleItem::DateOffset#unit
    module Unit
      extend MetronomeSDK::Internal::Type::Enum

      DAYS = :DAYS
      WEEKS = :WEEKS
      MONTHS = :MONTHS
      YEARS = :YEARS

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end
end

Instance Attribute Details

#date_offset ⇒ MetronomeSDK::Models::V1::PackageCreateParams::ScheduledCharge::Schedule::ScheduleItem::DateOffset

Date relative to the contract start date.

Returns:



2183
2184
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2183

required :date_offset,
-> { MetronomeSDK::V1::PackageCreateParams::ScheduledCharge::Schedule::ScheduleItem::DateOffset }

#quantity ⇒ Float

Quantity for the charge. Will be multiplied by unit_price to determine the amount.

Returns:

  • (Float) 


2191
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2191

required :quantity, Float

#unit_price ⇒ Float

Unit price for the charge. Will be multiplied by quantity to determine the amount.

Returns:

  • (Float) 


2198
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2198

required :unit_price, Float