Class: MetronomeSDK::Models::V1::PackageCreateParams::Commit::InvoiceSchedule::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::Commit::InvoiceSchedule::ScheduleItem for more details.

Parameters:



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 530

class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
  # @!attribute date_offset
  #   Date relative to the contract start date.
  #
  #   @return [MetronomeSDK::Models::V1::PackageCreateParams::Commit::InvoiceSchedule::ScheduleItem::DateOffset]
  required :date_offset,
           -> { MetronomeSDK::V1::PackageCreateParams::Commit::InvoiceSchedule::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::Commit::InvoiceSchedule::ScheduleItem}
  #   for more details.
  #
  #   @param date_offset [MetronomeSDK::Models::V1::PackageCreateParams::Commit::InvoiceSchedule::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::Commit::InvoiceSchedule::ScheduleItem#date_offset
  class DateOffset < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute unit
    #
    #   @return [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::Commit::InvoiceSchedule::ScheduleItem::DateOffset::Unit]
    required :unit,
             enum: -> { MetronomeSDK::V1::PackageCreateParams::Commit::InvoiceSchedule::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::Commit::InvoiceSchedule::ScheduleItem::DateOffset::Unit]
    #   @param value [Integer]

    # @see MetronomeSDK::Models::V1::PackageCreateParams::Commit::InvoiceSchedule::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::Commit::InvoiceSchedule::ScheduleItem::DateOffset

Date relative to the contract start date.

Returns:



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

required :date_offset,
-> { MetronomeSDK::V1::PackageCreateParams::Commit::InvoiceSchedule::ScheduleItem::DateOffset }

#quantity ⇒ Float

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

Returns:

  • (Float) 


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

required :quantity, Float

#unit_price ⇒ Float

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

Returns:

  • (Float) 


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

required :unit_price, Float