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,
sig/metronome_sdk/models/v1/package_create_params.rbs

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:



2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2352

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.

Parameters:

  • value (MetronomeSDK::V1::PackageCreateParams::ScheduledCharge::Schedule::ScheduleItem::DateOffset)

Returns:



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

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.

Parameters:

  • value (Float)

Returns:

  • (Float) 


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

required :quantity, Float

#unit_price ⇒ Float

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

Parameters:

  • value (Float)

Returns:

  • (Float) 


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

required :unit_price, Float

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


2241
 
# File 'sig/metronome_sdk/models/v1/package_create_params.rbs', line 2241

def to_hash: -> {